/**
 * Copyright (c) 2009 Noel Ang
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
package com.lunarshades.samsara.logging;

/**
 * A consumer of Loggable objects.
 *
 * @author Noel Ang, sparta.variable@gmail.com
 */
public abstract class Logger {

protected Logger() {
}

/**
 * Consume the specified event.
 *
 * @param event A Loggable object.
 *
 * @throws IllegalStateException if {@link #dispose()} has been previously
 *                               invoked.
 */
public abstract void log(Loggable event);

/**
 * Decides if the specified event is fit for consumption.
 *
 * @param event The event whose suitability is to be determined.
 *
 * @return True if the specified event would cause a subsequent call to the
 *         implementation's {@link #log(Loggable)} to be meaningful; false
 *         otherwise.
 */
public abstract boolean accept(Loggable event);

/**
 * Discard the logger instance. This method provides a chance for an
 * implementation to free up resources. Once this method is called the object
 * should no longer be used; its behaviour after that point is undefined.
 */
public abstract void dispose();

public static final String NEWLINE = "\n";
public static final String SPACE = " ";
}
